SCS Sensor Configuration Editor

Fixed Data Fields

Data Fields represent the smallest element a sensor's data stream can be broken down into.  Each Data Field should correspond to a single data item such as a Latitude, Longitude, Course, Speed, Depth, etc.  Fixed Data Fields are parsed out of the full RAW data string by setting a start and end position.  For instance, below is the start of defining the indices of the fields from an example of a full TSG RAW message:

    t1= 27.7553, c1= 5.55991, s= 34.7398, sv=1540.216, t2= 27.6226

27.7553

5.55991

34.7398

Finding the start and end character indices can be difficult to do by eye.  You can copy a line of the output and paste it into a text editor to get them or use a tool such as the Serial Port Diagnostics helper, etc.  

Fixed fields have a hard and locked start/end index but the actual data itself might grow and shrink (imagine a temperature going from 99 degrees to 100 degrees).  As such it is highly advisable to have a buffer around your start/end indices (include the empty white space in front and behind your data field if at all possible).  

The Basic tab consists of the following fields:

• Description
  • Provide an optional description of this item. 
• System Name
  • System generated name, read only format standard across all SCS systems.  
  • Useful for post-processing data on shore from multiple different sources/vessels.
  • Useful for rotating personnel as each ship will always comply with this format.
  • If you wish to have a more user friendly name you can edit the Display Name attribute below
• Display Name
  • User supplied name
  • Can be anything you wish though must be unique.
• Type
  • The Type of DataField Interface being defined.  
  • This is set upon creation and cannot be changed after the fact.
• Category
  • The category/genre of data this field should fall into.  
  • This must be set appropriately as many calculated interfaces and other sub-systems rely on this setting to filter and generate their inputs/outputs.
• Units
  • The unit of data this field's value is in
• Is Eligible Base Field
  • A flag letting CFE know if this field should be selectable when generating calculated interfaces and equations.
  • This flag will also block usage of this field in QA/QC.
• Calculated Interface References
  • Will appear if this field is used by any calculated interfaces, hidden otherwise.
  • Will show you all Calculated Interfaces using this field and provides a button to quickly navigate you to them.
• Starting Position
  • The index where the field starts (recommended to include empty white space in front of the value if at all possible!)
• Ending Position
  • The index where the field ends (recommended to include empty white space behind the value if at all possible!)

The Advanced tab consists of the following fields:

• Comment
  • A general comment pertaining to this item
• Keywords
  • Optional tags used to assist with text searches and metadata
• Precision
  • The number of digits after the decimal point
• Include as Data Source for Category
  • A flag letting SCS know if the field should be considered as a reference source for it's category.
  • Priority of this field is relative to others in the same category based upon the installed Physical Device Reference Order
• Exclude from SAMOS calculations
  • A flag letting SCS know if the field should be averaged and sent to SAMOS.
  • Only applies to fields SAMOS are interested in (eg has no effect on data that wouldn't be going to SAMOS regardless, such as 'winch tension')
• Code Translations
  • A table of data field values and their translations.  It is used to translate coded data field values into a string meaningful to users.  The translated string replaces the original code in the RAW file and in all data displays

Latitude / Longitude Categories

If you set the fields category to a Latitude or a Longitude you must also specify the format.  In the Advanced tab you must also specify the Lat/Lon Direction Field Position (the North/South East/West portion of the data).

Time / DateTime Categories

If you set the fields category to a Time or Date/Time you should specify the format of the timestamp string.  

Geographic Point Category

The Geographic Point Category is used internally by SCS, you should not use it in your normal course of building out your configuration in CFE.

SCSv5                                                                                                        Page 1 of 1